Skip to main content

Start-IMVideoTranscode

SYNOPSIS​

Starts video transcoding jobs for Immich assets

SYNTAX​

Start-IMVideoTranscode [[-Session] <ImmichSession>] [-Id] <String[]> [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Initiates video transcoding jobs for one or more video assets, creating web-optimized versions for better streaming and compatibility. This is useful for reprocessing videos or generating transcoded versions when they are missing or corrupted.

EXAMPLES​

EXAMPLE 1​

Start-IMVideoTranscode -Id 'video-asset-uuid'

Starts transcoding for the specified video asset with confirmation prompt.

EXAMPLE 2​

Get-IMAsset | Where-Object {$_.type -eq 'VIDEO'} | Start-IMVideoTranscode

Starts transcoding for all video assets in the library.

EXAMPLE 3​

@('video1-uuid', 'video2-uuid') | Start-IMVideoTranscode -Confirm:$false

Starts transcoding for multiple video assets without confirmation.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The UUID(s) of the video asset(s) to transcode. Accepts pipeline input and multiple values.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

This cmdlet supports ShouldProcess and will prompt for confirmation before starting transcoding jobs. Transcoding is a CPU-intensive operation that may take significant time depending on video size and server resources. Only works with video assets; image assets will be ignored.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github